home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / disk & file tools / hdenv / hdenv.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  8KB  |  157 lines

  1. @database HDEnv.guide
  2. @rem $VER: HDEnv.guide 1.3 (3.10.95)
  3. @rem Copyright (C) 1995 by Michael Fedrowitz
  4. @smartwrap
  5. @node main "HDEnv.guide"
  6. @{b}HDEnv 1.3 (3.10.95)@{ub}
  7. Copyright (C) 1995 by Michael Fedrowitz
  8.     This program is free software; you can redistribute it and/or modify it
  9. under the terms of the GNU General Public License as published by the Free
  10. Software Foundation; either version 2 of the License, or (at your option) any
  11. later version.
  12.     This program is distributed in the hope that it will be useful, but
  13. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14. FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. @{"GNU General Public License" link COPYING/main} for more details.
  16.     You should have received a copy of the GNU General Public License along
  17. with this program; if not, write to the Free Software Foundation, Inc., 675
  18. Mass Ave, Cambridge, MA 02139, USA.
  19.         @{"Introduction" link intro}             What's it all about?
  20.         @{"Requirements" link require}             Requirements
  21.         @{"Usage       " link usage}             How to use HDEnv
  22.         @{"Updating    " link update}             Updating from an earlier release
  23.         @{"Installation" link inst}             How to install HDEnv
  24.         @{"Sources     " link source}             Sources
  25.         @{"Bugs        " link bugs}             Bugs? What bugs?
  26.         @{"Todo        " link todo}             The future...
  27.         @{"History     " link History/main}             Revision history
  28.         @{"Address     " link addr}             How to reach the author
  29.         @{"Credits     " link credits}             Credits
  30. @endnode
  31. @node intro "Introduction"
  32. @{b}Introduction@{ub}
  33.     On every system startup the contents of the ENVARC: directory is copied to
  34. ENV:, which usually resides in RAM Disk. As the RAM Disk has a block size of
  35. 1K, every file, no matter how small, uses at least 2K of RAM (one for the file
  36. header and one for data). Furthermore ENVARC: usually contains lots of small
  37. files. Thus there are easily several 100K of valuable memory wasted. The
  38. alternative is keeping ENV: on the harddisk, but then, in order to emulate the
  39. original behaviour, you would have to delete the contents of ENV: and copy
  40. ENVARC: back to ENV: on every startup, what takes a lot of time.
  41. This is where HDEnv comes in.
  42. HDEnv is a little program, which will:
  43.     * delete files, which are in ENV:, but not in ENVARC:, from ENV:,
  44.     * copy files, which are either missing or have been modified in ENV:, from
  45. ENVARC: to ENV:.
  46. @endnode
  47. @node require "Requirements"
  48. @{b}Requirements@{ub}
  49.     HDEnv should run any Amiga equiped with AmigaOS 2.04 (V37) or higher. A
  50. harddisk isn't actually required, but without one this program will be
  51. virtually useless. As HDEnv relies on the filedates to decide what is to be
  52. copied, a battery backed up clock is highly recommended. (It should also work
  53. without one, but that hasn't been tested.)
  54. @endnode
  55. @node usage "Usage"
  56. @{b}Usage@{ub}
  57.     If you run HDEnv without any arguments, it will update your ENV:
  58. directory. There's no need to redirect output, as it won't print anything to
  59. stdout unless an error occurs.
  60. HDEnv accepts the following command line options:
  61.     * VERBOSE will output all actions taken during the process.
  62.     * TEST will output, what files would have been copied/deleted without
  63. actually changing anything on your harddisk.
  64. @endnode
  65. @node update "Updating"
  66. @{b}Updating@{ub}
  67.     Since version 1.1.3 HDEnv doesn't create a script anymore, but copies and
  68. deletes files directly. So when you're updating from an earlier version you'll
  69. have to:
  70.     * Copy the HDEnv executable to C: (don't forget to delete CopyEnv and
  71. DelEnv, if you're updating from a version prior to 1.0.4).
  72.     * Remove the commands to create, execute and delete the script from your
  73. startup-sequence and insert the command 'HDEnv' (without any options) instead.
  74.     For details on the new command line options see the chapter
  75. @{"Usage" link usage}.
  76.     If you're updating from version 1.1.3 or later, all you have to do is to
  77. replace the old HDEnv executable by the new one or by HDEnv.v39, if you're
  78. using AmigaOS 3.0 (V39) or higher.
  79. @endnode
  80. @node inst "Installation"
  81. @{b}Installation@{ub}
  82.     To install HDEnv copy the HDEnv executable to C: (if you're using
  83. AmigaOS 3.0 (V39) or later, you can use HDEnv.v39 instead). Now create a new
  84. directory on your harddisk to hold you ENV: directory (e.g. SYS:Env), and
  85. copy the contents of ENVARC: to that directory (be sure to use the 'CLONE'
  86. option, so that the filedates are preserved). Next you'll have to edit your
  87. Startup-sequence:
  88.     * Remove the 'RAM:ENV' and 'RAM:ENV/Sys' from the MakeDir command.
  89.     * Delete the 'Copy ENVARC: RAM:ENV ALL' line.
  90.     * Change the 'RAM:ENV' in the 'Assign ENV: ...' line to your new
  91. directory.
  92.     * Insert the command 'HDEnv' after the Assign commands.
  93.     When you reboot your system now, everything should be like usual, except
  94. for a short harddisk access whenever a file in ENV: (e.g. an environment
  95. variable or a prefs file) is used.
  96. @endnode
  97. @node source "Sources"
  98. @{b}Sources@{ub}
  99.     The full sources for SAS/C(tm) V6.55 are included and you are free to
  100. modify them under the terms of the @{"GPL" link COPYING/main}. However I'd ask
  101. you to send all modifications to @{"me" link addr}, so that I can coordinate
  102. new releases.
  103.     The sources aren't particularly nice and also completely undocumented, but
  104. I believe everything is pretty straightforward. An smakefile is provided, so
  105. you can recompile HDEnv simply by typing 'smake'.
  106. @endnode
  107. @node bugs "Bugs"
  108. @{b}Bugs@{ub}
  109. There shouldn't be any serious bugs left over in this release. However there
  110. are two minor problems:
  111.     * HDEnv will sometimes copy files, which don't really have to be copied:
  112. HDEnv copies all files from ENVARC: to ENV:, which have different datestamps.
  113. That way you can be virtually 100% sure that ENV: will really contain the same
  114. files as ENVARC:.
  115.     * HDEnv will break on Ctrl-D as well as on Ctrl-C: This is because
  116. SAS/C(tm) treats both in exactly the same way, and there doesn't seem to be
  117. any way to tell them apart. Please let me know, if you know a solution for
  118. this.
  119. If you find any other bugs, please report them to @{"me" link addr}.
  120. @endnode
  121. @node todo "Todo"
  122. @{b}Todo@{ub}
  123.     Well, there's not really very much left to do. At least I can't think of
  124. anything right now. But suggestions are of course always welcome.
  125.     So this will probably be the last release of HDEnv in its current form.
  126. But maybe there will be an HDEnv 2.0 implemented as a DOS handler, which will
  127. reduce the overhead to minimum. If and when I will actually implement that,
  128. highly depends on the amount of @{"feedback" link addr} I receive!
  129. @endnode
  130. @node addr "Address"
  131. @{b}Address@{ub}
  132. Send any comments, bug reports, enhancements to the source, etc. to:
  133. (Donations of any kind are of course also welcome.)
  134.     Michael Fedrowitz
  135.     Felsenstr. 60
  136.     74081 Heilbronn
  137.     Germany
  138.     mfedrowi@ix.urz.uni-heidelberg.de
  139.     2:246/1045.5@fidonet
  140. From 15 Oct to 15 Feb and 15 Apr to 15 Jul you can also use the following
  141. address (valid until summer 1997):
  142.     Michael Fedrowitz
  143.     Im Neuenheimer Feld 696
  144.     69120 Heidelberg
  145.     Germany
  146. It is highly recommended to use email. If you want a response via snail mail,
  147. please include an SASE, if you're living inside Germany, one IRC, if you're
  148. living inside Europe, two IRCs otherwise. IRCs should be available at your
  149. local post office.
  150. @endnode
  151. @node credits "Credits"
  152. @{b}Credits@{ub}
  153. The following tools were used to create this program:
  154.     * SAS/C(tm) V6.55 by SAS Institute Inc.
  155.     * GoldED 3.1.3 by Dietmar Eilert
  156. @endnode
  157.